/*
 * Copyright 2006-2008 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package net.martinimix.dao;

/**
 * Provides a template for saving and updating business objects.
 * 
 * @author Scott Rossillo
 *
 */
public interface BusinessObjectTemplate {
	
	/**
	 * Inserts the given bean into the database.
	 * 
	 * @param bean the bean to save
	 * 
	 * @param type the business object type for the given bean
	 * 
	 * @return a copy of the saved <code>bean</code>
	 */
	public Object insert(Object bean, String type);
	
	/**
	 * Updates the given bean in the database.
	 * 
	 * @param bean the bean to save
	 * 
	 * @param type the business object type for the given bean
	 * 
	 * @return a copy of the saved <code>bean</code>
	 */
	public Object update(Object bean, String type);
	
	/**
	 * Saves the given bean in the database.
	 * 
	 * @param bean the bean to save
	 * 
	 * @param type the business object type for the given bean
	 * 
	 * @param isNew <code>true</code> if the bean should be
	 * inserted; <code>false</code> to update an existing record
	 * 
	 * @return a copy of the saved <code>bean</code>
	 */
	public Object save(Object bean, String type, boolean isNew);

}
